View attributes LrView edit view properties

These properties are used by controls with editable text: edit_field, combo_box, and password_field.

Properties marked for numeric edit fields are not applicable to combo_box or password_field controls.

Summary

alignment
Alignment of text in frame.
auto_completion
True to auto-complete as the user types, using the completion table.
completion
A table of strings for completion, or, on Mac, it can also be a function that returns a table of strings.
immediate
True to validate the value as the user is typing.
increment
For numeric edit fields, increment the value by this amount if Shift is not down.
large_increment
For numeric edit fields, increment the value by this amount if Shift is held down.
max
For numeric edit fields, the maximum value allowed.
min
For numeric edit fields, the minimum value allowed.
placeholder_string
A placeholder displayed by the field until a value is supplied or, on Windows, the user puts focus on the item.
precision
For numeric edit fields, the number of decimal places to display.
string_to_value
An optional conversion function, called to convert the display string to a non-string value.
text_color
The color of displayed text.
validate
A function called to validate the value.
value
The display text.
value_to_string
An optional conversion function, called to convert a non-string value to a display string.
wraps
True to wrap text.

Properties

alignment : (Read-Only)
Alignment of text in frame. Values are 'left', 'center', 'right'. (string, default: 'left')

First supported in version 1.3 of the Lightroom SDK.

auto_completion : (Read-Only)
True to auto-complete as the user types, using the completion table. On Mac, 'completion' can also be a function. (Boolean, default: false)
completion : (Read-Only)
A table of strings for completion, or, on Mac, it can also be a function that returns a table of strings. (table or function, default: nil) The function takes this form: 
myCompletion( view, partialWord )

Parameters:

  1. view (LrView) This control.
  2. partialWord (any) The partial word to be completed.

Returns:

  1. result (array of strings) Strings that can complete the partial word.

First supported in version 1.3 of the Lightroom SDK.

immediate : (Read-Only)
True to validate the value as the user is typing. The validate function is called for every change, but the new value returned by the validate function does not replace the text the user is typing until the field loses the input focus.

When false, the value is committed when the control loses the input focus. In Windows, this happens when the user types Enter or clicks outside the control. In Mac OS, it happens only when the user types Enter; clicking outside the control does not cause it to lose focus and commit.

(Boolean, default: false)

First supported in version 1.3 of the Lightroom SDK.

increment : (Read-Only)
For numeric edit fields, increment the value by this amount if Shift is not down. If the precision is 0 then the default is 1, otherwise the default is 0.1. (number, default: 1 or 0.1)

First supported in version 1.3 of the Lightroom SDK.

large_increment : (Read-Only)
For numeric edit fields, increment the value by this amount if Shift is held down. If the precision is 0 then the default is 10, otherwise the default is 1. (number, default: 10 or 1)

First supported in version 1.3 of the Lightroom SDK.

max : (Read-Only)
For numeric edit fields, the maximum value allowed. (number, default: nil)

First supported in version 1.3 of the Lightroom SDK.

min : (Read-Only)
For numeric edit fields, the minimum value allowed. (number, default: nil)

First supported in version 1.3 of the Lightroom SDK.

placeholder_string : (Read-Only)
A placeholder displayed by the field until a value is supplied or, on Windows, the user puts focus on the item. (String, default: nil)

e.g. placeholder_string = "Enter your new value here"

precision : (Read-Only)
For numeric edit fields, the number of decimal places to display. If specified, the field is numeric. (number, default: 2)

First supported in version 1.3 of the Lightroom SDK.

string_to_value : (Read-Only)
An optional conversion function, called to convert the display string to a non-string value. (function, default: nil) The function takes this form: 
myStringToValue( view, string )

Parameters:

  1. view (LrView) This control.
  2. string (any) The display string.

Returns:

  1. result (any) Value of the required type.

First supported in version 1.3 of the Lightroom SDK.

text_color : (Read-Only)
The color of displayed text. Mac only for Lightroom 3 and earlier. (LrColor, default: black)
validate : (Read-Only)
A function called to validate the value. (function, default: nil) The function takes this form: 
myValidate( view, value )

Parameters:

  1. view (LrView) This control.
  2. value (any) The value to validate.

Returns three values:

  1. result (Boolean) True if value was valid.
  2. value (any) The new value.
  3. message (string) If result is false, an error message.

First supported in version 1.3 of the Lightroom SDK.

value : (Read-Only)
The display text. (any, default: nil)

First supported in version 1.3 of the Lightroom SDK.

value_to_string : (Read-Only)
An optional conversion function, called to convert a non-string value to a display string. (function, default: nil) The function takes this form: 
myValueToString( view, value )

Parameters:

  1. view (LrView) This control.
  2. value (any) The entered value.

Returns:

  1. result (string) Display string.

First supported in version 1.3 of the Lightroom SDK.

wraps : (Read-Only)
True to wrap text. Mac only. (Boolean, default: true)